home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr34 / arcid111.zip / ARCID.DOC < prev    next >
Text File  |  1995-02-04  |  12KB  |  269 lines
  1.  
  2.     ┌──────────────────────────────┐
  3.     │                              │
  4.     │  ╖────╖            ╖     ┐   │           Archive Identifier
  5.     │  ║    ║            ║     │   │
  6.     │  ║────╢ ┐──┐ ┌──┐  ║ ┌───│   │              Version 1.11
  7.     │  ║    ║ │    │     ║ │   │   │
  8.     │  ╜    ╜ ┘    └──┘  ╜ └───┘   │  (c) Copyright 1992-1995 - Stacy Smith
  9.     │                              │
  10.     └──────────────────────────────┘
  11.  
  12.                                   Courtesy of:
  13.  
  14.                          The Bloom Beacon-Picayune BBS
  15.         Node 1: *** DOWN *** (USRobotics Courier Dual Standard HST/V.34)
  16.                                     FidoNet
  17.                                      ILink
  18.                                     Intelec
  19.  
  20.                                   Stacy Smith
  21.  
  22.  
  23. ┌────────────────────┐
  24. │  1. Introduction:  │
  25. └────────────────────┘
  26.  
  27. Archive Identifier (ARCID) is a derivative of the UpLoadProcessor (ULP) system;
  28. users of ULP do not require this program, as each of the ULP programs have
  29. ARCID's abilities built into it.
  30.  
  31. ARCID is intended for use by people who wish to be able to accurately detect a
  32. archive's format without relying on the file extension, but do not wish to use
  33. ULP.  These people may be sysops using EXZTEST, ZIPLAB, ZDCS, FWKCS, etc., or
  34. may be using their own homemade batch files for testing archives, or even other
  35. purposes I haven't thought of.
  36.  
  37. Regardless, ARCID is an extremely simple and fast tool for people who deal with
  38. compressed files on a regular basis.
  39.  
  40.  
  41. ┌──────────────────────────────────────┐
  42. │  2. Features of Archive Identifier:  │
  43. └──────────────────────────────────────┘
  44.  
  45.       ∙ Native versions for both 16-bit DOS and 32-bit OS/2!
  46.       ∙ Identifies ARC, ARJ, HYP, LZH, PAK, SQZ, ZIP, ZOO, GIF and JPG files,
  47.         regardless of their file extensions (ideal for software distribution
  48.         networks, like .SDN files).
  49.       ∙ Identifies ARJ, LZH, SQZ and ZIP self-extracting (SFX) archives.
  50.       ∙ Can filter other file types based solely upon file extension.
  51.       ∙ A total of 97 archive formats and files extensions can be defined for
  52.         conditional branching of batch files.
  53.       ∙ Fully network-aware using DOS SHARE-compatible locks.
  54.       ∙ Written in C for optimal speed, using Watcom C/C++ 10.0.
  55.  
  56.  
  57. ┌───────────────────────────────────────────────────────┐
  58. │  3. Files Included in the ARCID Distribution Archive  │
  59. └───────────────────────────────────────────────────────┘
  60.  
  61.         !NOTICE!        Information regarding support and registration.
  62.         ARCID.COM       Archive Identifier processing program (16-bit DOS).
  63.         ARCID2.EXE      Archive Identifier processing program (32-bit OS/2).
  64.         PCBTEST.BAT     Sample PCBTEST.BAT file for using ARCID.
  65.         SLOWDRV.BAT     Sample SLOWDRV.BAT file for using ARCID.
  66.         ARCID.DOC       This file.
  67.         SUPPORT.DOC     List of authorized support sites for my shareware.
  68.         HISTORY.DOC     ARCID revision history in reverse order.
  69.         REGISTER.FRM    Registration form for ARCID.
  70.         FILE_ID.DIZ     Internal description file.
  71.  
  72. When you unzip the distribution archive, you should see my PKZIP authenticity
  73. verification stamp, and a '-AV' after every file in the archive:
  74.  
  75.         # SSU301    The Bloom Beacon-Picayune BBS
  76.  
  77. If there are any files missing or added, or the -AV stamp is missing, the
  78. archive has been tampered with.  It would be advisable to call my BBS (listed
  79. at the top of this document) or one of the support sites listed in the
  80. SUPPORT.DOC file for the latest version of ARCID.
  81.  
  82.  
  83. ┌───────────────────────────┐
  84. │  4. Program Requirements  │
  85. └───────────────────────────┘
  86.  
  87. To the best of my knowledge, this program will run on most any machine capable
  88. of running the popular archivers in use today.  My BBS setup is DESQview on a
  89. LANtastic network, but other sysops that I have been in contact with have
  90. successfully implemented ARCID on setups with CD-ROMs and other varying
  91. hardware.
  92.  
  93. ARCID has been developed and tested using archives created by the following
  94. archiving packages:
  95.  
  96.         ARJ 2.10 and higher (by Robert Jung)
  97.         HYPER 2.5 (by P. Sawatzki and K. P. Nischke)
  98.         LHA 2.12 and higher (by Haruyasu Yoshizaki)
  99.         LHarc 1.13c (by Haruyasu Yoshizaki)
  100.         PAK 2.51 (by NoGate Consulting)
  101.         PKPAK 3.61 (by PKWare)
  102.         PKZIP 1.10 and higher (by PKWare)
  103.         SQZ 1.08.2 (by Jonas Hammarberg)
  104.         ZOO 2.01 and higher (by Rahul Deshi)
  105.  
  106. as well as the GIF87, GIF89 and JPEG graphic format standards.
  107.  
  108. The ARCID system requires DOS 3.x and up or OS/2 2.x and up, as it uses DOS
  109. SHARE-compatible file reads and writes.
  110.  
  111. ARCID's memory requirements are extremely small (less than 64K).  For the batch
  112. file operations, however, it would be a good idea to have as much free
  113. conventional memory as possible (ARCID itself cannot use EMS or XMS memory, and
  114. really couldn't use it if I wanted it to), since the archivers may require a
  115. significant amount of memory.
  116.  
  117.  
  118. ┌───────────────────┐
  119. │  5. Registration  │
  120. └───────────────────┘
  121.  
  122. The ARCID system is not free; nor is ARCID is crippled to force registration.
  123. ARCID is fully functional, and will always remain so.  The only variation with
  124. the registered copies is no beg message and time delay.
  125.  
  126. Why register?  Besides a clean conscience, you will get a diskette that
  127. includes the latest version and a registration key that will work for all
  128. future versions of ARCID, and will remove the message and brief time delay at
  129. the end of execution of ARCID.
  130.  
  131. The registration fee for your unique code is $15 for non-commercial BBSes.  The
  132. registration fee for commercial BBSes, defined if you run your BBS in the
  133. course of a commercial business (e.g. more than 10 nodes), is $20.  Please
  134. print the file REGISTER.FRM and fill it out.  You can print out the form by
  135. issuing the following command from the DOS prompt:
  136.  
  137.         TYPE REGISTER.FRM > PRN
  138.  
  139.  
  140. ┌───────────────────────────────────────┐
  141. │  6. License, Warranty and Disclaimer  │
  142. └───────────────────────────────────────┘
  143.  
  144. I'll keep this part short and sweet, and dispense with the legal-ese:
  145.  
  146.     License: You are allowed to use ARCID for 30 days, after which you must
  147.         either register ARCID or stop using it completely. ARCID registration
  148.         is a license for your use of ARCID; I retain ownership of the software.
  149.         A single registration applies to a single BBS system, regardless of the
  150.         number of computers used in the system. If you run two or more distinct
  151.         BBS systems on the same computer (with different names), you require
  152.         two or more ARCID registrations. Refer to the registration form for the
  153.         currect pricing structure.
  154.  
  155.     Warranty: There isn't one. The only thing I'll guarantee is that ARCID will
  156.         take up disk space, and will disappear when deleted.
  157.  
  158.     Disclaimer: I'm not responsible for anything bad that happens. ARCID works
  159.         here, but I cannot be held responsible for it not working on your
  160.         computer or doing any damage to hardware or software.
  161.  
  162. If these aren't agreeable with you, then the best thing to do is delete ARCID
  163. right now. I'll do my best to help any user (registered or not) that wants to
  164. use ARCID, and I'll act on bug reports quickly, but I simply cannot and will
  165. not be responsible for anything bad, like lost data, disk crashes, or whatever
  166. else you can think of.
  167.  
  168.  
  169. ┌───────────────────┐
  170. │  7. Installation  │
  171. └───────────────────┘
  172.  
  173. GENERAL:
  174. ────────
  175. Copy the file ARCID.COM into a subdirectory that is included in the DOS and/or
  176. OS/2 path, so that ARCID may be executed from anywhere. I would suggest your
  177. PCB home directory, usually 'C:\PCB\'.  If you have registered ARCID, place
  178. a copy of your ARCID.KEY file in the same subdirectory as the ARCID
  179. executable(s).
  180.  
  181. If you are running your BBS under a DOS network or a multitasking operating
  182. system, you should already have DOS's SHARE.EXE loaded.  You must have SHARE
  183. loaded in order to take advantage of the file sharing and locking methods used
  184. by the DOS ARCID program to prevent data loss.  (If you are running a
  185. single-node system without a multitasker, SHARE is not needed).
  186.  
  187. Note that for the ARCID programs, you can obtain a limited program syntax
  188. screen simply by executing the program name with no arguments.
  189.  
  190. FOR UPLOAD TESTING USING 'PCBTEST.BAT':
  191. ───────────────────────────────────────
  192. NOTE: If you are unfamiliar with the operation of PCBTEST.BAT, you will need
  193. to refer to the PCBoard manual for an explanation of PCBTEST.BAT and/or
  194. TESTFILE.EXE.
  195.  
  196. As necessary, refer to the sample PCBTEST.BAT file included in this
  197. archive.  This simple batch file will test archive integrity and check for
  198. viruses for any of the detectable formats of ARCID.  This batch file can easily
  199. be expanded to perform more tests.
  200.  
  201. ARCID.COM is a drop-in replacement of PCBoard's TESTFILE.EXE.  If you are
  202. already using TESTFILE.EXE, then simply replace the TESTFILE command in your
  203. batch file with ARCID.  For example, if your current PCBTEST.BAT has the
  204. following line:
  205.  
  206.     TESTFILE %1 ZIP ARJ LZH GIF
  207.  
  208. simply change it to:
  209.  
  210.     ARCID %1 ZIP ARJ LZH GIF
  211.  
  212. ARCID will return a DOS errorlevel corresponding to the archive's position in
  213. the extension list; for example, if the file passed via %1 is an LZH file,
  214. ARCID will return an errorlevel of 3.  If the file is identified as one of the
  215. listed formats, ARCID will return an errorlevel of 98.  ARCID is capable of
  216. automatically detecting the formats identified by the following extensions,
  217. regardless of the file's true extension:
  218.  
  219.     ARC     for ARC/PKPAK archives
  220.     ARJ     for ARJ and ARJ self-extracting archives
  221.     GIF     for GIF picture files
  222.     HYP     for HYPER archives
  223.     JPG     for JPEG/JFIF picture files
  224.     LZH     for LHA/LHARC and LHA/LHARC self-extracting archives
  225.     PAK     for PAK and PAK self-extracting archives
  226.     SQZ     for SQZ and SQZ self-extracting archives
  227.     ZIP     for PKZIP and PKZIP self-extracting archives
  228.     ZOO     for ZOO version 2.x archives
  229.  
  230. Do not add 'EXE' to the extension list; ARCID will automatically return to
  231. corresponding errorlevel for an identified self-extracting archive.
  232.  
  233.  
  234. ┌──────────────────────────┐
  235. │  8. The Future of ARCID  │
  236. └──────────────────────────┘
  237.  
  238. ARCID will be supported as long as I'm in the BBSing business (which will be
  239. quite a while...once it's in your blood, you can never shake it <grin>).  The
  240. ARCID system will be rapidly expanding it's features; some current plans:
  241.  
  242.       ∙ Install code to detect archives containing explicit paths.
  243.       ∙ Install code to detect defective or hacked archives.
  244.  
  245. If you have any other suggestions, or want other archivers supported, please
  246. contact me by Internet, U.S. snail-mail or on my BBS at the number at the top
  247. of this document.
  248.  
  249. Thanks for giving ARCID a try!
  250.  
  251.  
  252. ┌────────────────────────────────┐
  253. │  Appendix A:  DOS Errorlevels  │
  254. └────────────────────────────────┘
  255.  
  256. The errorlevels returned to DOS by the ARCID system programs are consistent
  257. among all of the programs (primarily with the error conditions); the following
  258. is a list of the errorlevels than can be returned by the ARCID programs, along
  259. with which programs return the codes:
  260.  
  261.         0       Successful brand of the ARCID executable
  262.         1-97    Successful execution, archive identified
  263.         98      Successful execution, archive NOT identified
  264.         99      Unsuccessful execution, no arguments passed (help screen
  265.                    displayed)
  266.         110     Unable to allocate heap memory (disk buffer)
  267.         112     Invalid registration key
  268.         115     Invalid filename provided by user on command-line
  269.